Skip to main content

Introduction

Webhooks allow you to automate custom backend actions in response to the transitions that happen in a add stamp flow.

What edeXa webhooks are​

Webhooks are a mechanism for real-time communication between applications or services. They are user-defined HTTP callbacks that are triggered by specific events or updates from one application and sent to another. Instead of periodically polling for updates, webhooks allow for instant notifications when certain events occur.

Here's how webhooks typically work:​

  • An application or service registers a webhook with another application or service.
  • When a specific event or trigger occurs in the source application, it sends an HTTP POST request to the registered webhook URL.
  • The receiving application, known as the webhook endpoint, processes the incoming request and takes appropriate actions based on the provided data.
  • The endpoint can respond with an acknowledgment or perform further processing as needed.

Webhooks enable real-time data synchronization, event-driven workflows, and seamless integration between different systems. They are commonly used in various scenarios, such as notifying about new data, triggering actions or workflows, updating external systems, and facilitating automated processes.

Webhooks advantages are:​

  • Efficiency: Webhooks minimize unnecessary API calls, resulting in resource optimization.
  • Speed: Near real-time data exchange, eliminating dependence on polling intervals.
  • Stateless: Webhooks eliminate the need for client-side state management between API calls.
  • Extensibility: Webhooks provide a mechanism for extending applications and enabling subscriptions for customized functionality.

Why use edeXa webhooks​

  • Let’s say you’ve registered to receive the hash.success and hash.failure event and a user trigger the Add stamp api in your app or website. A webhook between edeXa and your app tells your app whether the user's stamping is successful or failed.
  • The events triggered by webhooks will only be effective if the user has subscribed to those specific events.

Steps to receive webhooks​

  • Identify the events you want to monitor and the event payloads to parse.
  • Create a webhook endpoint as an HTTP endpoint (URL) on your local server.
  • Handle requests from edeXa by parsing each event object and returning 200 response status codes.
  • Deploy your webhook endpoint so it’s a publicly accessible HTTPS URL.
  • Register your publicly accessible HTTPS URL in the edeXa explorer.

Webhook Integration​

  • As an developer if you are here first time so for more better understanding, become a part of edeXa Universe, To gain a comprehensive understanding of the edeXa ecosystem and it's role within your requirement, refer to the detailed documentation available on our platform Getting Started
  • If you are already a part of the edeXa Ecosystem and seeking detailed information on webhook configuration, please refer to the Webook Configration.
  • This resource provides comprehensive guidance on configuring webhooks within the edeXa platform, offering step-by-step instructions to ensure a seamless integration process.

🖖 Become a part of bStamp community​

Connect and get the latest updates of bStamp : bStamp Discord

Last updated on